New Func backend: First iteration #559
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
+ Func syntax tree + Essential functionality Func formatter + A new `codegen` package that includes the updated backend + Hacks in the compilation pipeline that allow to use both backends which is needed for differential testing.
Needed for bottom-up AST generation; e.g. function definiton might be generated from the expression that calls it.
Needed to test the backend leveraging structural typing in TS
Both backends generated some extra garbage.
Still idk, why things went wrong with that identifier there, as identifiers elsewhere work just fine
And semantically accurate function arguments (just tensors), albeit at the cost of some expressiveness of FunC
|
A summary of our recent conversation with @anton-trunov:
Some goals we would like to achieve in the new backend later:
Thus, I suggest limiting the scope of this backend to the following:
After implementing this, I suggest to merge this PR and add more functionality to it iteratively, covering it with tests. |
How about adding the new experimental option for this. Like, {
"projects": [
{
"name": "some_prefix",
"path": "./contract.tact",
"output": "./contract_output",
"options": {
"experimental": {
"newFuncBackend": true
}
}
}
]
}P.S.: Whoops, a miss-click — didn't mean to close the PR, sorry! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #526
Closes #619 (FunC grammar & parser by @novusnota)
Main roadmap
Write AST/formatter, and utilities to generate and emit Func code.It should be rewritten entirely at this step, since everything is interconnected in the old backend, and there are no any unit tests checking any specific functionality of the generated code.
The previous backend is basically untested. It requires to write a number of Tact contracts and setup code coverage to ensure that all the implemented features of the new backend work in the same way as in the old one.
Sub-roadmap of @novusnota
The goal is to create a comprehensive FunC grammar and parsed using the Ohm parsing toolkit. Should cover FunC version 0.4.4:
#pragma ...grammar.ohm)semantics.addOperation)#include ...global ...const ...ton-blockchain/tonmonorepoCurrent progress
Support JSON dumps for debugging purposessrc/generators/writers/write*.ts; similar code structure if possible)ExpressionStatementFunctionLiteralContractConstantWriteContext)src/generators/resolveFunc.*.ts)"used" identifiersWriteContext. The existing structure based on.context/.usedcalls is too imperative and makes the source code unreadable. Thus, a better design should be developed.src/codegen/README.md)mainincorporating upstream changes to the new backend:Write new unit tests if neededWrite unit tests for the codegen, since we don't have anyNotes
yarn build && NEW_CODEGEN=1 PRINT_FUNC=1 ./bin/tact --config <project.config.json>. It will print the generated source in stdout. UnsetNEW_CODEGENto run the same with the old backend.yarn test src/codegen/codegen.spec.tsFuncAstprefix. When creating a separate packge, we could remove theFuncpart; and add it only to our project. This could be done creating a separate module that includesindex.tswith public exports like:export { AstComment as FuncAstComment } from '@func-package-name';